Data Model
Service Request Configuration Entity
| PROPERTY | NAME | DATA TYPE | DESCRIPTION |
|---|---|---|---|
|
KEY_PARTITION |
requestConfigId |
string | Unique identifier for the configuration |
|
INDEX |
type |
string | Reference Type of the config |
|
INDEX |
subType |
string | Reference SubType of the config |
|
|
endPointCommandName |
string | Fabric endpoint of an integration/Orchestration service in the format of serviceName#operationName |
|
|
maxAttempt |
number | Max. no. of attempts allowed |
|
|
adminApprovalRequired |
Boolean | Admin Approval Required or not |
|
|
notificationEnabled |
Boolean | Is notification enabled ? |
|
|
notificationStages |
array of string | Stages of notification |
|
|
awaitMaxRetryAttempt |
number | Max no of retry attempts for awaiting Endpoint |
|
|
awaitEnabled |
Boolean | Do you have another endpoint to check the status of the request created ? |
|
|
awaitEndpoint |
string | Fabric endpoint of an integration/Orchestration service in the format of serviceName#operationName , to check the status of any request created previously. |
|
|
preSubmissionValidationScript |
string | JS validation script , to validate input upon submission |
|
|
requestAttribute |
collection of RequestAttribute | Request Payload / Input Payload |
|
|
eventSource |
string | Kafka or Fabric Server Events? |
|
|
realTime |
Boolean | Real Time enabled or Near Realtime |
|
|
product |
string | Product the request belongs to |
|
INDEX |
prefix |
string | Prefix used to generate Service Request ID |
| defaultStatus | string | Default status, if no status is matched in mapper | |
| statusConfigurationMapper | string | JSON Map, with key as Source Status and value as Target Status. The engine uses this as reference, to transform the status from backend response into the desired target status defined by the User. |
RequestAttribute Entity
| PROPERTY | NAME | DATA TYPE | DESCRIPTION |
|---|---|---|---|
|
|
requestConfigId |
string | Unique ID of the Configuration |
|
|
attributeName |
string | Name of the payload attribute |
|
|
mandatory |
Boolean | Mandatory or not ? |
|
|
dataType |
string | Primitive datatype of the value expected |
|
|
maxLength |
number | Max allowed length of characters of the attribute's value |
|
|
allowedValues |
array of string | Allowed values |
ServiceRequest Entity
| PROPERTY | NAME | DATA TYPE | EXAMPLE | DESCRIPTION |
| serviceReqId | string | ORD127REDFDSAS | Unique ID of the service Request | |
| externalServiceReqRef | string | ORD12HNFU34I4N5 | Identifier provided by the external system as part of the response | |
| description | string | The Service request is to replace the card | Description of the Service Request | |
| INDEX | partyId | string | 100100 | Customer ID of the Requester |
| INDEX | accountId | string | GB0010001-89707 | Account ID of the Requester |
| INDEX | type | string | Card | Reference Type of the config |
| INDEX | subType | string | replaceCard | Reference subType of the config |
| currentAttempt | number | 5 | No. of attempts | |
| INDEX | requestConfigId | string | replaceCard | Unique ID of the configuration |
| serviceReqRequestIn | string | checkIssueId: SB.2406 | Request Payload sent as Input | |
| note: CreateNew | ||||
| serviceReqResponse | string | httpStatus: '200' | Response Payload received from backend system | |
| dbpError: '' | ||||
| errorDetails | string | Nil | Error Details , if any | |
| INDEX | serviceReqStatus | string | Request Placed | Overall Status of the Service Request |
| externalStatus | string | Issued, Request received, Success | External Status received from the backend | |
| internalStatus | string | ReInitiated/Awaiting | Internal Status as per SR Lifecycle | |
| INDEX | serviceReqProcessedTime | string | 2020-08-20T06:01:01.729Z | Time of Processing a service request |
| KEY_SORT | requestDate | string | 8/20/2020 | Date of Service Request Creation |
| responseAttributes | string | httpStatus: '200' | Response Payload from backend system | |
| dbpError: '' | ||||
| actionPerformed | string | CREATE | Last action performed, cancel or update or create | |
| currrentSignatoryApprovedCount | number | 2 | Number of approval done by signatory | |
| currentSignatoryRejectCount | number | 0 | Number of rejection done by signatory | |
| requestCreatedTime | date | 2020-08-20T06:01:01.729Z | TimeStamp of request creation | |
| errorMessage | string | Transformation Failed | Error Message from backend, if any | |
| additionalInfo | string | Operation was successfully completed with this additional info | Additional Info from backend, if any | |
| signatoryApprovalRequired | Boolean | TRUE | signatory Approved or NotactionPerformed | |
| INDEX | legalEntityId | string | GB0010001 | Branch company code |
| customerName | string | james Gosling | (NEW) Name of the customer who creates the Service Request | |
| INDEX | bankReferenceName | string | que_<name of the queue>/ username such as bankofficer1, servicingops1 | (NEW) This field holds the name of the queue in which a request is placed until it is claimed for processing and later holds the username of bank user who claims the request |
| INDEX | parentProcessId | string | 2044 | (NEW) Holds the identifier of the Parent process initiated for performing a task/series of tasks on a service request |
| INDEX | activeProcessId | string | 1023 | (NEW) Holds the identifier of the sub process (that is part of a parent process) which is currently active and performs a specific task related to a service request |
| INDEX | requestStage | string | Open, In Progress, Completed | (NEW) Indicates the current stage of the service request which had been placed in the bank user's queue |
| adminApprovalCount | number | 1 | (NEW) Number of approval done by bank admins | |
| adminRejectionCount | number | 0 | (NEW) Number of rejection done by bank admins | |
| signatoryComments | string | Check Book Request Approved | (NEW) Comments provided by Signatory for Approval/Rejection | |
| adminComments | string | Check Book Request Approved | (NEW) Comments provided by Bank Admin for Approval/Rejection |
AuditHistory Entity
| PROPERTY | NAME | DATA TYPE | DESCRIPTION |
|---|---|---|---|
| KEY_PARTITION | serviceReqId | string | Service Request ID |
| INDEX | signatoryUserId | string | User ID of a signatory |
| signatoryDate | Date | Date of signatory action | |
| signatoryAction | string | Action performed | |
| comments | string | Comments | |
| lastupdatedTimeStamp | string | Time Stamp of update |
ServiceRequestConfiguration Entity
Note: The ServiceRequestConfiguration Entity has an attribute called requestAttribute. It is an array of datatype RequestAttribute.
| PROPERTY | NAME | DATA TYPE | DESCRIPTION |
|---|---|---|---|
|
KEY_PARTITION |
requestConfigId |
string | Unique identifier for the configuration |
|
INDEX |
type |
string | Reference Type of the config |
|
INDEX |
subType |
string | Reference SubType of the config |
|
|
endPointCommandName |
string | Fabric endpoint of an integration/Orchestration service in the format of serviceName#operationName |
|
|
maxAttempt |
number | Max. no. of attempts allowed |
|
|
adminApprovalRequired |
Boolean | Admin Approval Required or not |
|
|
notificationEnabled |
Boolean | Is notification enabled ? |
|
|
notificationStages |
array of string | Stages of notification |
|
|
awaitMaxRetryAttempt |
number | Max no of retry attempts for awaiting Endpoint |
|
|
awaitEnabled |
Boolean | Do you have another endpoint to check the status of the request created ? |
|
|
awaitEndpoint |
string | Fabric endpoint of an integration/Orchestration service in the format of serviceName#operationName , to check the status of any request created previously. |
|
|
preSubmissionValidationScript |
string | JS validation script , to validate input upon submission |
|
|
requestAttribute |
collection of RequestAttribute | Request Payload / Input Payload |
|
|
eventSource |
string | Kafka or Fabric Server Queue ? |
|
|
realTime |
Boolean | Real Time enabled or Near Realtime |
|
|
product |
string | Product the request belongs to |
|
INDEX |
prefix |
string | Prefix used to generate Service Request ID |
| defaultStatus | string | Default status, if no status is matched in mapper | |
| statusConfigurationMapper | string | JSON Map, with key as Source Status and value as Target Status. The engine uses this as a reference, to transform the status from the backend response into the desired target status defined by the User. | |
| updateEnabled | Boolean | A switch to determine whether Updating a request after backend has processed it is enabled or disabled | |
| updateEndPoint | string | Fabric Endpoint in the format, serviceName#OperationName | |
| cancelEnabled | Boolean | A switch to determine whether canceling a request after backend has processed it is enabled or disabled | |
| cancelEndPoint | string | Fabric Endpoint in the format, serviceName#OperationName | |
| legalEntityId | string | Branch company code |
RequestAttribute Entity
| NAME | DATA TYPE | DESCRIPTION |
|---|---|---|
|
requestConfigId |
string | Unique ID of the Configuration |
|
attributeName |
string | Name of the payload attribute |
|
mandatory |
Boolean | Mandatory or not ? |
|
dataType |
string | Primitive datatype of the value expected |
|
maxLength |
number | Max allowed length of characters of the attribute's value |
|
allowedValues |
array of string | Allowed values |
ServiceRequest Entity
| PROPERTY | NAME | DATA TYPE | DESCRIPTION |
|---|---|---|---|
|
|
serviceReqId |
string | Unique ID of the service Request |
|
|
externalServiceReqRef |
string | Identifier provided by the external system as part of the response |
|
|
description |
string | Description of the Service Request |
|
INDEX |
partyId |
string | Customer ID of the Requester |
|
INDEX |
accountId |
string | Account ID of the Requester |
|
INDEX |
type |
string | Reference Type of the config |
| INDEX | subType | string | Reference subType of the config |
| currentAttempt | number | No. of attempts | |
| INDEX | requestConfigId | string | Unique ID of the configuration |
| serviceReqRequestIn | string | Request Payload sent as Input | |
| serviceReqResponse | string | Response Payload received from backend system | |
| errorDetails | string | Error Details , if any | |
| INDEX | serviceReqStatus | string | Overall Status of the Service Request |
| externalStatus | string | External Status received from the backend | |
| internalStatus | string | Internal Status as per SR Lifecycle | |
| INDEX | serviceReqProcessedTime | string | Time of Processing a service request |
| KEY_SORT | requestDate | string | Date of Service Request Creation |
| responseAttributes | string | Response Payload from backend system | |
| actionPerformed | string | (NEW) Last action performed, cancel or update or create | |
| requestCreatedTime | date | (NEW) TimeStamp of request creation | |
| errorMessage | string | (NEW) Error Message from backend, if any | |
| additionalInfo | string | (NEW) Additional Info from backend, if any | |
| legalEntityId | string | Branch company code |
AuditHistory Entity
| PROPERTY | NAME | DATA TYPE | DESCRIPTION |
|---|---|---|---|
|
KEY_PARTITION |
serviceReqId |
string | Service Request ID |
|
INDEX |
signatoryUserId |
string | User ID of a signatory |
|
|
signatoryDate |
Date | Date of signatory action |
|
|
signatoryAction |
string | Action performed |
|
|
comments |
string | Comments |
|
|
lastupdatedTimeStamp |
string | Time Stamp of update |
SRAttribute History Entity (NEW)
| PROPERTY | NAME | DATA TYPE | DESCRIPTION |
|---|---|---|---|
|
KEY_PARTITION |
serviceReqId |
string | Service Request ID |
|
KEY_SORT |
Version |
string | version of Service Request |
|
|
action |
string | Action performed |
|
|
changedpayload |
string | change in payload |
Note: There are no changes for the Data Model since the last release(202107). To view the Service Request Data Model for 202107 release, click here.
ServiceRequest Entity
| PROPERTY | NAME | DATA TYPE | EXAMPLE | DESCRIPTION |
| serviceReqId | string | ORD127REDFDSAS | Unique ID of the service Request | |
| externalServiceReqRef | string | ORD12HNFU34I4N5 | Identifier provided by the external system as part of the response | |
| description | string | The Service request is to replace the card | Description of the Service Request | |
| INDEX | partyId | string | 100100 | Customer ID of the Requester |
| INDEX | accountId | string | GB0010001-89707 | Account ID of the Requester |
| INDEX | type | string | Card | Reference Type of the config |
| INDEX | subType | string | replaceCard | Reference subType of the config |
| currentAttempt | number | 5 | No. of attempts | |
| INDEX | requestConfigId | string | replaceCard | Unique ID of the configuration |
| serviceReqRequestIn | string | checkIssueId: SB.2406 | Request Payload sent as Input | |
| note: CreateNew | ||||
| serviceReqResponse | string | httpStatus: '200' | Response Payload received from backend system | |
| dbpError: '' | ||||
| errorDetails | string | Nil | Error Details , if any | |
| INDEX | serviceReqStatus | string | Request Placed | Overall Status of the Service Request |
| externalStatus | string | Issued, Request received, Success | External Status received from the backend | |
| internalStatus | string | ReInitiated/Awaiting | Internal Status as per SR Lifecycle | |
| INDEX | serviceReqProcessedTime | string | 2020-08-20T06:01:01.729Z | Time of Processing a service request |
| KEY_SORT | requestDate | string | 8/20/2020 | Date of Service Request Creation |
| responseAttributes | string | httpStatus: '200' | Response Payload from backend system | |
| dbpError: '' | ||||
| actionPerformed | string | CREATE | Last action performed, cancel or update or create | |
| currrentSignatoryApprovedCount | number | 2 | Number of approval done by signatory | |
| currentSignatoryRejectCount | number | 0 | Number of rejection done by signatory | |
| requestCreatedTime | date | 2020-08-20T06:01:01.729Z | TimeStamp of request creation | |
| errorMessage | string | Transformation Failed | Error Message from backend, if any | |
| additionalInfo | string | Operation was successfully completed with this additional info | Additional Info from backend, if any | |
| signatoryApprovalRequired | Boolean | TRUE | signatory Approved or NotactionPerformed | |
| legalEntityId | string | GB0010001 | Branch company code | |
| customerName | string | james Gosling | (NEW) Name of the customer who creates the Service Request | |
| INDEX | bankReferenceName | string | que_<name of the queue>/ username such as bankofficer1, servicingops1 | (NEW) This field holds the name of the queue in which a request is placed until it is claimed for processing and later holds the username of bank user who claims the request |
| INDEX | parentProcessId | string | 2044 | (NEW) Holds the identifier of the Parent process initiated for performing a task/series of tasks on a service request |
| INDEX | activeProcessId | string | 1023 | (NEW) Holds the identifier of the sub process (that is part of a parent process) which is currently active and performs a specific task related to a service request |
| INDEX | requestStage | string | Open, In Progress, Completed | (NEW) Indicates the current stage of the service request which had been placed in the bank user's queue |
| adminApprovalCount | number | 1 | (NEW) Number of approval done by bank admins | |
| adminRejectionCount | number | 0 | (NEW) Number of rejection done by bank admins | |
| signatoryComments | string | Check Book Request Approved | (NEW) Comments provided by Signatory for Approval/Rejection | |
| adminComments | string | Check Book Request Approved | (NEW) Comments provided by Bank Admin for Approval/Rejection |
ServiceRequestConfiguration Entity
Note: The ServiceRequestConfiguration Entity has an attribute called requestAttribute, which is an array of datatype RequestAttribute
| PROPERTY | NAME | DATA TYPE | EXAMPE | DESCRIPTION |
| KEY_PARTITION | requestConfigId | string | replaceCard | Unique identifier for the configuration |
| INDEX | type | string | Card | Reference Type of the config |
| INDEX | subType | string | replaceCard | Reference SubType of the config |
| endPointCommandName | string | T24ISSTOPPAYMENTS_CREATECHEQUEBOOKREQUESTS | Fabric endpoint of an integration/Orchestration service in the format of serviceName#operationName | |
| maxAttempt | number | 15 | Max. no. of attempts allowed | |
| adminApprovalRequired | Boolean | TRUE | Admin Approval Required or not | |
| notificationEnabled | Boolean | TRUE | Is notification enabled? | |
| notificationStages | array of string | Initiated | Stages of notification | |
| Processed | ||||
| awaitMaxRetryAttempt | number | 15 | Max no of retry attempts for awaiting Endpoint | |
| awaitEnabled | Boolean | TRUE | Do you have another endpoint to check the status of the request created? | |
| awaitEndpoint | string | T24ISSTOPPAYMENTS_CREATECHEQUEBOOKREQUESTS | Fabric endpoint of an integration/Orchestration service in the format of serviceName#operationName, to check the status of any request created previously. | |
| preSubmissionValidationScript | string | zhfuifnerDSAHRIOnjfsaduf+oHDSNFEO=UR184145+62 | JS validation script, to validate input upon submission | |
| requestAttribute | collection of RequestAttribute | Request Payload / Input Payload | ||
| eventSource | string | api | Kafka or Fabric Server Events? | |
| realTime | Boolean | TRUE | Real-Time enabled or Near Realtime | |
| product | string | Card | Product the request belongs to | |
| INDEX | prefix | string | CRD | The prefix used to generate Service Request ID |
| defaultStatus | string | Default status, if no status is matched in mapper | ||
| statusConfigurationMapper | string | ISSUED: ORDER CONFIRMED | JSON Map, with key as Source Status and value as Target Status. The engine uses this as a reference, to transform the status from the backend response into the desired target status defined by the User. | |
| (Map) | REQUEST RECIEVED: ORDER RECIEVED | |||
| updateEnabled | Boolean | TRUE | A switch to determine whether Updating a request after backend has processed it is enabled or disabled | |
| updateEndPoint | string | T24ISSTOPPAYMENTS_CREATECHEQUEBOOKREQUESTS | Fabric Endpoint in the format, serviceName#OperationName | |
| cancelEnabled | Boolean | TRUE | A switch to determine whether canceling a request after backend has processed it is enabled or disabled | |
| cancelEndPoint | string | T24ISSTOPPAYMENTS_CREATECHEQUEBOOKREQUESTS | Fabric Endpoint in the format, serviceName#OperationName | |
| legalEntityId | string | GB0010001 | Branch company code |
RequestAttribute Entity
| PROPERTY | NAME | DATA TYPE | EXAMPE | DESCRIPTION |
| requestConfigId | string | replaceCard | Unique ID of the Configuration | |
| attributeName | string | ChequeIssueId/note | Name of the payload attribute | |
| mandatory | Boolean | TRUE | Mandatory or not? | |
| dataType | string | string | The primitive data type of the value expected | |
| maxLength | number | 15 | Max allowed length of characters of the attribute's value | |
| allowedValues | array of string | - SB.2406 | Allowed values | |
| - SB.2568 |
AuditHistory Entity
| PROPERTY | NAME | DATA TYPE | EXAMPLE | DESCRIPTION |
| KEY_PARTITION | serviceReqId | string | SR127REDFDSAS | Service Request ID |
| INDEX | signatoryUserId | string | 1000101 | User ID of a signatory |
| signatoryDate | Date | 2020-08-20T06:01:01.729Z | Timestamp on which the action is performed by the user | |
| signatoryAction | string | Approved/Rejected | Action performed | |
| comments | string | Required document needs to be submitted | comments provided by the user during action performed | |
| lastupdatedTimeStamp | string | 2020-08-20T06:01:01.729Z | Time Stamp of update | |
| approverType | string | admin/signatory | (NEW) Type of the approver | |
| approverName | string | John Durairaj | (NEW) The name of the person who approves the request | |
| isFinalAction | Boolean | TRUE | (NEW) Indicates whether the final action is performed or not | |
| actionType | string | Decision/Amendment | (NEW) Type of action performed |
SRAttribute History Entity (NEW)
| PROPERTY | NAME | DATA TYPE | EXAMPE | DESCRIPTION |
| KEY_PARTITION | serviceReqId | string | SR127REDFDSAS | Service Request ID |
| KEY_SORT | Version | string | 1 | version of Service Request |
| action | string | cancel/update | Action performed | |
| changedpayload | string | chequeBookId: 5 | change in payload |
ServiceRequest Entity
| PROPERTY | NAME | DATA TYPE | EXAMPLE | DESCRIPTION |
| serviceReqId | string | ORD127REDFDSAS | Unique ID of the service Request | |
| externalServiceReqRef | string | ORD12HNFU34I4N5 | Identifier provided by the external system as part of the response | |
| description | string | The Service request is to replace the card | Description of the Service Request | |
| INDEX | partyId | string | 100100 | Customer ID of the Requester |
| INDEX | accountId | string | GB0010001-89707 | Account ID of the Requester |
| INDEX | type | string | Card | Reference Type of the config |
| INDEX | subType | string | replaceCard | Reference subType of the config |
| currentAttempt | number | 5 | No. of attempts | |
| INDEX | requestConfigId | string | replaceCard | Unique ID of the configuration |
| serviceReqRequestIn | string | checkIssueId: SB.2406 | Request Payload sent as Input | |
| note: CreateNew | ||||
| serviceReqResponse | string | httpStatus: '200' | Response Payload received from backend system | |
| dbpError: '' | ||||
| errorDetails | string | Nil | Error Details , if any | |
| INDEX | serviceReqStatus | string | Request Placed | Overall Status of the Service Request |
| externalStatus | string | Issued, Request received, Success | External Status received from the backend | |
| internalStatus | string | ReInitiated/Awaiting | Internal Status as per SR Lifecycle | |
| INDEX | serviceReqProcessedTime | string | 2020-08-20T06:01:01.729Z | Time of Processing a service request |
| KEY_SORT | requestDate | string | 8/20/2020 | Date of Service Request Creation |
| responseAttributes | string | httpStatus: '200' | Response Payload from backend system | |
| dbpError: '' | ||||
| actionPerformed | string | CREATE | Last action performed, cancel or update or create | |
| currrentSignatoryApprovedCount | number | 2 | Number of approval done by signatory | |
| currentSignatoryRejectCount | number | 0 | Number of rejection done by signatory | |
| requestCreatedTime | date | 2020-08-20T06:01:01.729Z | TimeStamp of request creation | |
| errorMessage | string | Transformation Failed | Error Message from backend, if any | |
| additionalInfo | string | Operation was successfully completed with this additional info | Additional Info from backend, if any | |
| signatoryApprovalRequired | Boolean | TRUE | signatory Approved or NotactionPerformed | |
| INDEX | legalEntityId | string | GB0010001 | Branch company code |
| customerName | string | james Gosling | (NEW) Name of the customer who creates the Service Request | |
| INDEX | bankReferenceName | string | que_<name of the queue>/ username such as bankofficer1, servicingops1 | (NEW) This field holds the name of the queue in which a request is placed until it is claimed for processing and later holds the username of bank user who claims the request |
| INDEX | parentProcessId | string | 2044 | (NEW) Holds the identifier of the Parent process initiated for performing a task/series of tasks on a service request |
| INDEX | activeProcessId | string | 1023 | (NEW) Holds the identifier of the sub process (that is part of a parent process) which is currently active and performs a specific task related to a service request |
| INDEX | requestStage | string | Open, In Progress, Completed | (NEW) Indicates the current stage of the service request which had been placed in the bank user's queue |
| adminApprovalCount | number | 1 | (NEW) Number of approval done by bank admins | |
| adminRejectionCount | number | 0 | (NEW) Number of rejection done by bank admins | |
| signatoryComments | string | Check Book Request Approved | (NEW) Comments provided by Signatory for Approval/Rejection | |
| adminComments | string | Check Book Request Approved | (NEW) Comments provided by Bank Admin for Approval/Rejection |
ServiceRequestConfiguration Entity
Note: The ServiceRequestConfiguration Entity has an attribute called requestAttribute, which is an array of datatype RequestAttribute
| PROPERTY | NAME | DATA TYPE | EXAMPE | DESCRIPTION |
| KEY_PARTITION | requestConfigId | string | replaceCard | Unique identifier for the configuration |
| INDEX | type | string | Card | Reference Type of the config |
| INDEX | subType | string | replaceCard | Reference SubType of the config |
| endPointCommandName | string | T24ISSTOPPAYMENTS_CREATECHEQUEBOOKREQUESTS | Fabric endpoint of an integration/Orchestration service in the format of serviceName#operationName | |
| maxAttempt | number | 15 | Max. no. of attempts allowed | |
| adminApprovalRequired | Boolean | TRUE | Admin Approval Required or not | |
| notificationEnabled | Boolean | TRUE | Is notification enabled? | |
| notificationStages | array of string | Initiated | Stages of notification | |
| Processed | ||||
| awaitMaxRetryAttempt | number | 15 | Max no of retry attempts for awaiting Endpoint | |
| awaitEnabled | Boolean | TRUE | Do you have another endpoint to check the status of the request created? | |
| awaitEndpoint | string | T24ISSTOPPAYMENTS_CREATECHEQUEBOOKREQUESTS | Fabric endpoint of an integration/Orchestration service in the format of serviceName#operationName, to check the status of any request created previously. | |
| preSubmissionValidationScript | string | zhfuifnerDSAHRIOnjfsaduf+oHDSNFEO=UR184145+62 | JS validation script, to validate input upon submission | |
| requestAttribute | collection of RequestAttribute | Request Payload / Input Payload | ||
| eventSource | string | api | Kafka or Fabric Server Events? | |
| realTime | Boolean | TRUE | Real-Time enabled or Near Realtime | |
| product | string | Card | Product the request belongs to | |
| INDEX | prefix | string | CRD | The prefix used to generate Service Request ID |
| defaultStatus | string | Default status, if no status is matched in mapper | ||
| statusConfigurationMapper | string | ISSUED: ORDER CONFIRMED | JSON Map, with key as Source Status and value as Target Status. The engine uses this as a reference, to transform the status from the backend response into the desired target status defined by the User. | |
| (Map) | REQUEST RECIEVED: ORDER RECIEVED | |||
| updateEnabled | Boolean | TRUE | A switch to determine whether Updating a request after backend has processed it is enabled or disabled | |
| updateEndPoint | string | T24ISSTOPPAYMENTS_CREATECHEQUEBOOKREQUESTS | Fabric Endpoint in the format, serviceName#OperationName | |
| cancelEnabled | Boolean | TRUE | A switch to determine whether canceling a request after backend has processed it is enabled or disabled | |
| cancelEndPoint | string | T24ISSTOPPAYMENTS_CREATECHEQUEBOOKREQUESTS | Fabric Endpoint in the format, serviceName#OperationName | |
| INDEX | legalEntityId | string | GB0010001 | Branch company code |
RequestAttribute Entity
| PROPERTY | NAME | DATA TYPE | EXAMPE | DESCRIPTION |
| requestConfigId | string | replaceCard | Unique ID of the Configuration | |
| attributeName | string | ChequeIssueId/note | Name of the payload attribute | |
| mandatory | Boolean | TRUE | Mandatory or not? | |
| dataType | string | string | The primitive data type of the value expected | |
| maxLength | number | 15 | Max allowed length of characters of the attribute's value | |
| allowedValues | array of string | - SB.2406 | Allowed values | |
| - SB.2568 |
AuditHistory Entity
| PROPERTY | NAME | DATA TYPE | EXAMPE | DESCRIPTION |
| requestConfigId | string | replaceCard | Unique ID of the Configuration | |
| attributeName | string | ChequeIssueId/note | Name of the payload attribute | |
| mandatory | Boolean | TRUE | Mandatory or not? | |
| dataType | string | string | The primitive data type of the value expected | |
| maxLength | number | 15 | Max allowed length of characters of the attribute's value | |
| allowedValues | array of string | - SB.2406 | Allowed values | |
| - SB.2568 |
SRAttribute History Entity
| PROPERTY | NAME | DATA TYPE | EXAMPE | DESCRIPTION |
| requestConfigId | string | replaceCard | Unique ID of the Configuration | |
| attributeName | string | ChequeIssueId/note | Name of the payload attribute | |
| mandatory | Boolean | TRUE | Mandatory or not? | |
| dataType | string | string | The primitive data type of the value expected | |
| maxLength | number | 15 | Max allowed length of characters of the attribute's value | |
| allowedValues | array of string | - SB.2406 | Allowed values | |
| - SB.2568 |
In this topic